\hypertarget{class_state_done_code}{
\section{StateDoneCode Class Reference}
\label{class_state_done_code}\index{StateDoneCode@{StateDoneCode}}
}


{\ttfamily \#include $<$StateDoneCode.hpp$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_state_done_code_a0131781cf44a425a9d7b72dc74c9f5aa}{
{\bfseries StateDoneCode} (int code)}
\label{class_state_done_code_a0131781cf44a425a9d7b72dc74c9f5aa}

\item 
\hypertarget{class_state_done_code_ad4e348045601f6626fde9d66968a27a7}{
{\bfseries StateDoneCode} (const \hyperlink{class_state_done_code}{StateDoneCode} \&code)}
\label{class_state_done_code_ad4e348045601f6626fde9d66968a27a7}

\item 
\hypertarget{class_state_done_code_add0a0fb7ac5626867698375c3eea7f5b}{
int {\bfseries GetCode} () const }
\label{class_state_done_code_add0a0fb7ac5626867698375c3eea7f5b}

\item 
\hypertarget{class_state_done_code_ad1900d7c280f39a4abd2a4229a9fec57}{
bool {\bfseries IsDone} () const }
\label{class_state_done_code_ad1900d7c280f39a4abd2a4229a9fec57}

\item 
\hypertarget{class_state_done_code_acad7202f96e292d5c3ae5d306d0d8500}{
bool {\bfseries IsError} () const }
\label{class_state_done_code_acad7202f96e292d5c3ae5d306d0d8500}

\item 
\hypertarget{class_state_done_code_ae004e125dbfabe22c2194fa5dfd9033b}{
bool {\bfseries operator==} (\hyperlink{class_state_done_code}{StateDoneCode} other) const }
\label{class_state_done_code_ae004e125dbfabe22c2194fa5dfd9033b}

\item 
\hypertarget{class_state_done_code_ac9988218e92e6ab4913d22e8fd654e47}{
bool {\bfseries operator!=} (\hyperlink{class_state_done_code}{StateDoneCode} other) const }
\label{class_state_done_code_ac9988218e92e6ab4913d22e8fd654e47}

\item 
\hypertarget{class_state_done_code_a63b3a8aa8483a92e37ce7498d2772513}{
bool {\bfseries operator$<$} (\hyperlink{class_state_done_code}{StateDoneCode} other) const }
\label{class_state_done_code_a63b3a8aa8483a92e37ce7498d2772513}

\item 
\hypertarget{class_state_done_code_a56826853af362da2db4b1aaa1a6b6b3c}{
bool {\bfseries operator$>$} (\hyperlink{class_state_done_code}{StateDoneCode} other) const }
\label{class_state_done_code_a56826853af362da2db4b1aaa1a6b6b3c}

\item 
\hypertarget{class_state_done_code_a510f9f34266163b92ff9927da69e39ce}{
bool {\bfseries operator$<$=} (\hyperlink{class_state_done_code}{StateDoneCode} other) const }
\label{class_state_done_code_a510f9f34266163b92ff9927da69e39ce}

\item 
\hypertarget{class_state_done_code_a9471edc62438b5ae7537f982a689cd61}{
bool {\bfseries operator$>$=} (\hyperlink{class_state_done_code}{StateDoneCode} other) const }
\label{class_state_done_code_a9471edc62438b5ae7537f982a689cd61}

\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_state_done_code_abebdd80075060f0e45d6aca85b7c5b3d}{
static \hyperlink{class_state_done_code}{StateDoneCode} {\bfseries GetNotYetCode} ()}
\label{class_state_done_code_abebdd80075060f0e45d6aca85b7c5b3d}

\item 
\hypertarget{class_state_done_code_a987fb089d47b6453c2083050c195bba4}{
static \hyperlink{class_state_done_code}{StateDoneCode} {\bfseries GetSuccessCode} ()}
\label{class_state_done_code_a987fb089d47b6453c2083050c195bba4}

\item 
\hypertarget{class_state_done_code_a5e6cb8a9ccafdff6fcbf9d4b31656f6c}{
static \hyperlink{class_state_done_code}{StateDoneCode} {\bfseries GetNotDoneCode} ()}
\label{class_state_done_code_a5e6cb8a9ccafdff6fcbf9d4b31656f6c}

\item 
\hypertarget{class_state_done_code_a87c673ffbc1141b7e217f3022ade82bf}{
static \hyperlink{class_state_done_code}{StateDoneCode} {\bfseries GetGenericErrorCode} ()}
\label{class_state_done_code_a87c673ffbc1141b7e217f3022ade82bf}

\item 
\hypertarget{class_state_done_code_a697fa5e3a37f7436919773feacf0870a}{
static \hyperlink{class_state_done_code}{StateDoneCode} {\bfseries GetCancelErrorCode} ()}
\label{class_state_done_code_a697fa5e3a37f7436919773feacf0870a}

\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_state_done_code_a7160df862da838ecab09f094684c75a1}{
int {\bfseries m\_\-code}}
\label{class_state_done_code_a7160df862da838ecab09f094684c75a1}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
The \hyperlink{class_state_done_code}{StateDoneCode} class is used as an exit code for States.

The \hyperlink{class_state}{State} class finishs by setting a \hyperlink{class_state_done_code}{StateDoneCode} other than \char`\"{}NotDone\char`\"{}.

Code -\/1 is reserved to indicate that the \hyperlink{class_state}{State} is not done yet. Codes \mbox{[}0, Inf) indicates an end result expected in a perfectly working program. Code 0 is reserved to indicate general success. Code 1 is reserved to indicate simply \char`\"{}not yet\char`\"{}. Useful for something like a \char`\"{}CheckSensorState\char`\"{}. Codes (-\/Inf, -\/2\mbox{]} indicates an error. Code -\/2 indicates a generic error. Code -\/3 indicates that the operation was canceled in an unintended manner. The entire range \mbox{[}-\/0x0A, 0x0A\mbox{]} is reserved to be definied by FPK. The rest of the codes may be defined anyway you like. 

The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
C:/Documents and Settings/Sam/My Documents/My Projects/Entech-\/Fpk/Entech-\/Fpk/StateDoneCode.hpp\item 
C:/Documents and Settings/Sam/My Documents/My Projects/Entech-\/Fpk/Entech-\/Fpk/StateDoneCode.cpp\end{DoxyCompactItemize}
